home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / pcrlg111.zip / PCRLOG.DOC < prev    next >
Text File  |  1992-03-09  |  14KB  |  342 lines
  1.  
  2.      ╔═══════════════════════════════════════════════════════════════╗
  3.      ║                             PCRLOG                            ║
  4.      ║                          version 1.11                         ║
  5.      ║                         March 9, 1992                         ║
  6.      ║               Copyright (c) 1992 by Mike Bennett              ║
  7.      ╚═══════════════════════════════════════════════════════════════╝
  8.  
  9.  
  10.      ╔═══════════════════════════════════════════════════════════════╗
  11.      ║                            PURPOSE                            ║
  12.      ╚═══════════════════════════════════════════════════════════════╝
  13.  
  14.      This program will read and summarize the log file created by the
  15.      PCRelay software, generate a report of the total HUB activity and
  16.      a summary of each node connecting with the HUB.  The output may
  17.      be redirected to a file for viewing and/or maintaining a history
  18.      record of your PCRelay activity.
  19.  
  20.      The program was originally created as a favor for one of my local
  21.      SysOps.  He had been flipping the long distance bill for calling
  22.      the Regional PCRelay Hub twice a day for mail packets.  Other
  23.      local nodes would in turn call him to take their conferences.  He
  24.      asked me to write this program to analyze the PCRelay log and
  25.      provide an accurate percentage of total bytes moved to each node.
  26.      This information could then be used to evenly divide the long
  27.      distance charges among the other local nodes.
  28.  
  29.      ╔═══════════════════════════════════════════════════════════════╗
  30.      ║                            FEATURES                           ║
  31.      ╚═══════════════════════════════════════════════════════════════╝
  32.  
  33.      - Not crippled in any way
  34.      - Completely configurable
  35.      - Optionally specify dates to begin/end the analysis
  36.      - Optionally specify individual nodes to include/exclude
  37.      - Optionally specify a dollar amount to be divided between the
  38.        nodes
  39.      - Output includes summary of Hub and Node activity
  40.      - Total bytes sent
  41.      - Total bytes received
  42.      - Total bytes combined
  43.      - Total time online
  44.      - Total number of connects
  45.      - Percentages for all byte counts
  46.      - Process multiple logs during a single pass
  47.  
  48.  
  49.  
  50.      ╔═══════════════════════════════════════════════════════════════╗
  51.      ║                     DISCLAIMER OF WARRANTY                    ║
  52.      ╚═══════════════════════════════════════════════════════════════╝
  53.  
  54.      This program and all supporting documentation are provided "as
  55.      is" without warranty of any kind, either expressed or implied,
  56.      including but not limited to the implied warranties of
  57.      merchantability and fitness for a particular purpose.  In no
  58.      event will the author be liable to you for any damages arising
  59.      out of the use or inability to use this program and/or all
  60.      supporting programs and documentation.
  61.  
  62.  
  63.  
  64.  
  65.      ╔═══════════════════════════════════════════════════════════════╗
  66.      ║                          REGISTRATION                         ║
  67.      ╚═══════════════════════════════════════════════════════════════╝
  68.  
  69.      This program is a copyrighted work.  Many hours of effort have
  70.      gone into the creation of this program.
  71.  
  72.      You have a limited license to operate this program on your
  73.      computer for a period of no more than 30 days free of charge. If,
  74.      after this trial period, you decide you would like to continue
  75.      using it, you must register the program. ANY OTHER USE OF THIS
  76.      PROGRAM IS A VIOLATION OF COPYRIGHT LAWS.
  77.  
  78.      To register the program please fill out the registration form
  79.      contained in REGISTER.DOC and sent it along with $10 to Mike
  80.      Bennett (the author).  Your registration gets you:
  81.  
  82.        - The right to continue to use PCRLOG for ever
  83.  
  84.        - The right to download and use any future versions of PCRLOG
  85.  
  86.        - A postcard from me with my thanks for supporting shareware
  87.  
  88.        - A clear conscience
  89.  
  90.      You are free to distribute the program to BBSs, shareware
  91.      vendors, etc., as long as you don't charge more than $2 for this
  92.      service and the COMPLETE archive is distributed.
  93.  
  94.  
  95.  
  96.      ╔═══════════════════════════════════════════════════════════════╗
  97.      ║                             USAGE                             ║
  98.      ╚═══════════════════════════════════════════════════════════════╝
  99.  
  100.      PCRLOG PCRelaylog1 <PCRelaylog2...> </cconfigfile>
  101.  
  102.       PCRelaylog1      REQUIRED
  103.                        The first PCRelay log to be analyzed. The full
  104.                        DOS path must be given if the file is not in
  105.                        the current directory.
  106.  
  107.       PCRelaylog2...   OPTIONAL
  108.                        The second, third, forth, etc. PCRelay log to
  109.                        be analyzed. The full DOS path must be given if
  110.                        the file(s) are not in the current directory.
  111.                        There is no limit internal to the PCRLOG
  112.                        program for the number of log files that may be
  113.                        processed during one pass.  However, DOS does
  114.                        have a 128 character limit on the command line.
  115.                        (4DOS users - the limit is 255)
  116.  
  117.          Sample command line:
  118.          PCRLOG PCRELAY1.LOG PCRELAY2.LOG
  119.             │       │            │
  120.             │       │            └───  PCRelay log file (PCRELAY2.LOG)                                            │       └────────────────  PCRelay log file (PCRELAY1.LOG)
  121.             │       └────────────────  PCRelay log file (PCRELAY1.LOG)
  122.             └────────────────────────  program (PCRLOG.EXE)
  123.  
  124.  
  125.       /cconfigfile   OPTIONAL
  126.                      The configuration file. The full DOS path must
  127.                      be given if the file is not in the current
  128.                      directory.
  129.                      This is an override switch that will prevent
  130.                      the use of the default config file named
  131.                      PCRLOG.CFG
  132.  
  133.          Sample command line:
  134.          PCRLOG PCRELAY.LOG /CLOCAL.CFG
  135.             │       │        │    │
  136.             │       │        │    │
  137.             │       │        │    └─  config file (LOCAL.CFG)
  138.             │       │        └──────  the /C switch
  139.             │       └───────────────  PCRelay log file (PCRELAY.LOG)
  140.             └───────────────────────  program (PCRLOG.EXE)
  141.  
  142.          !! IMPORTANT !! - Notice that there is NO space between the
  143.                            switch and the filename that follows.
  144.  
  145.  
  146.  
  147.  
  148.      ╔═══════════════════════════════════════════════════════════════╗
  149.      ║                           USAGE TIPS                          ║
  150.      ╚═══════════════════════════════════════════════════════════════╝
  151.  
  152.      If you want to maintain a history of you PCRLOG output, then from
  153.      the DOS prompt type:
  154.  
  155.      C:\PCRLOG PCRELAY.LOG >> HISTORY.LOG
  156.  
  157.      This will redirect the output to a file named HISTORY.LOG in the
  158.      current directory.  The 'double arrow' directs DOS to append any
  159.      output to the file.  Therefore, you will have a running history.
  160.  
  161.      Another nice idea is to pipe the output to either Vern Buerg's
  162.      LIST.COM or (for you 4DOS users) 4DOS's internal LIST.  The
  163.      command for this is:
  164.  
  165.      C:\PCRLOG PCRELAY.LOG | LIST /S
  166.  
  167.      This command works great for those times when you want to view
  168.      all of the information without necessarily saving it to disk.
  169.      While in either of the LIST programs, you can browse through all
  170.      of the output (even if it is more than one screen) using the LIST
  171.      commands that you are familiar with.
  172.  
  173.  
  174.  
  175.  
  176.  
  177.      ╔═══════════════════════════════════════════════════════════════╗
  178.      ║                       CONFIGURATION FILE                      ║
  179.      ╚═══════════════════════════════════════════════════════════════╝
  180.  
  181.      All entries as well as the file itself are optional.  An example
  182.      file is included named PCRLOG.CFG.  Note that the program will
  183.      accept any valid DOS filename for the config file.  Therefore you
  184.      may wish to create several different config files and choose one
  185.      of them at run time.
  186.  
  187.      The use of a config is optional.  Without a config file the
  188.      program will process the entire PCRelay log file.
  189.  
  190.      The default config file should be named PCRLOG.CFG.  It will be
  191.      used if it is in the current directory.  This may be overridden
  192.      by the use of the /c command line switch.
  193.  
  194.      The config file format is very simple.  There are five (5)
  195.      keywords that direct the program to act in different manners. The
  196.      keywords are:
  197.  
  198.      Include, Exclude, BeginDate, EndDate, Dollars
  199.  
  200.      The format of the config file is as follows:
  201.  
  202.      Include=NODEID1
  203.      Exclude=NODEID2
  204.      BeginDate=01/01/91
  205.      EndDate=12/31/91
  206.      Dollars=127.34
  207.  
  208.      The entries are not case sensitive and may be listed in any
  209.      order.  They MUST begin in column number 1 (all the way to the
  210.      left) and may only be listed one entry per line.  To Include 6
  211.      different nodes in the analysis would require 6 Include lines.
  212.      Each of the keywords are explained in detail below.
  213.  
  214.  
  215.  
  216.  
  217.      ╔═══════════════════════════════════════════════════════════════╗
  218.      ║                       INCLUDE / EXCLUDE                       ║
  219.      ╚═══════════════════════════════════════════════════════════════╝
  220.  
  221.      !!IMPORTANT!! - If a single entry is made with the 'Include'
  222.      keyword, indicating that you want the node to be included, then
  223.      only the specific nodes listed in the config file will be used in
  224.      the analysis process.  In other words if you want to list the
  225.      nodes to be included, you must list them all.  Any node not
  226.      listed in the config file will be ignored!  (This ONLY applies if
  227.      the 'Include' keyword is used.)
  228.  
  229.      This essentially means that there is no need to list both Include
  230.      and Exclude nodes in the same config file.  If you specify only
  231.      one node to be Included, then there is no need to specify any
  232.      Exclude nodes.
  233.  
  234.      Example:
  235.  
  236.      If your config file contained the following:
  237.  
  238.      Exclude=NODE-1
  239.  
  240.      Then all nodes in the log would be included in the analysis
  241.      except for node NODE-1.
  242.  
  243.      If your config file contained the following:
  244.  
  245.      Exclude=NODE-1
  246.      Include=NODE-2
  247.  
  248.      Then ONLY node NODE-2 would be included.  Even if the log
  249.      contained entries for NODE-3 and NODE-4 they would NOT be
  250.      included because they were not specifically listed to be
  251.      included.
  252.  
  253.  
  254.  
  255.  
  256.      ╔═══════════════════════════════════════════════════════════════╗
  257.      ║                      BEGINDATE / ENDDATE                      ║
  258.      ╚═══════════════════════════════════════════════════════════════╝
  259.  
  260.      The dates placed after the keyword MUST be in the format
  261.      MM/DD/YY. You may use any character to separate the month, day
  262.      and year.  The following are acceptable dates:
  263.  
  264.      12/15/91   01-15-92  01.01.91  05,15,92  03?13?91  09:30"92
  265.  
  266.      These are not valid:  2/3/91  06/6/91
  267.  
  268.      Specifying a BeginDate means that any session that STARTS on or
  269.      after this date will be included in the analysis.
  270.  
  271.      Specifying an EndDate means that any session that STARTS on or
  272.      before this date will be included in the analysis.
  273.  
  274.      You may specify both or neither for a complete analysis of the
  275.      entire log.
  276.  
  277.  
  278.  
  279.  
  280.      ╔═══════════════════════════════════════════════════════════════╗
  281.      ║                            DOLLARS                            ║
  282.      ╚═══════════════════════════════════════════════════════════════╝
  283.  
  284.      Here you may put a numeric entry that will be divided evenly
  285.      between all of the reported nodes based on their total byte
  286.      percentage.  The original purpose of this option was to allow the
  287.      SysOp to enter his monthly phone bill in this slot.
  288.  
  289.      The format is simple - just enter a number.  The decimal place is
  290.      optional.  You could enter 100 or 100.00 both would produce the
  291.      same result.  Note that 99999.99 is the maximum that the program
  292.      can handle.
  293.  
  294.      NOTE!! - Due to the rounding performed internally there is a
  295.      possibility that the dollar values displayed will be either plus
  296.      or minus $0.01.  I have tested the program using various numbers
  297.      and have never found the variance to be more than 1 penny.
  298.  
  299.  
  300.  
  301.  
  302.      ╔═══════════════════════════════════════════════════════════════╗
  303.      ║                            SUPPORT                            ║
  304.      ╚═══════════════════════════════════════════════════════════════╝
  305.  
  306.      You can download the latest version of PCRLOG, or receive
  307.      technical support, from the following board:
  308.  
  309.              THE TREE BBS  (PCBoard)
  310.              Sysop: Frank Fowler
  311.              (904) 732-0866  HST
  312.              (904) 732-8273  2400
  313.              PCRelay node ->THETREE
  314.  
  315.      I can also be reached through the RIME Shareware conference.
  316.      Please address all E-mail to "Mike Bennett"
  317.  
  318.  
  319.  
  320.  
  321.      ╔═══════════════════════════════════════════════════════════════╗
  322.      ║                            HISTORY                            ║
  323.      ╚═══════════════════════════════════════════════════════════════╝
  324.  
  325.      1.00    Thu  03-05-1992
  326.              initial public release.
  327.  
  328.      1.01    Sat  03-07-1992
  329.              HUB ID's containing numeric characters were not being
  330.              recognized.  Fixed.
  331.              Minor update to the docs to elaborate on the /C command
  332.              line switch and its usage.
  333.  
  334.      1.10    Sun  03-08-1992
  335.              Added support for multiple log files to be processed
  336.              during a single run.
  337.  
  338.      1.11    Mon  03-09-1992
  339.              Fix a bug that prevented the dollar amount from being
  340.              calculated.  Thanks for the bug report Rex Hankins!
  341.  
  342.